﻿///////////////////////////////////////////////////////////////////////////////
//
// This file is part of the BassDrop project
//   https://code.google.com/p/bass-drop/
//
//
// Creator:	Gergely Krajcsovszki (krajcsovszkig@hotmail.com)
// Date:	2013-12-23 19:55
//
//
// Copyright © 2013-2014. Gergely Krajcsovszki
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
///////////////////////////////////////////////////////////////////////////////
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace BassDrop.Core.Common.Options.Items
{
	/// <summary>
	/// OptionsItem for showing some text
	/// </summary>
	/// 
	public class TextOptionsItem : OptionsItemBase
	{
		/// <summary>
		/// The way the setting is presented
		/// </summary>
		public DisplayType PresentationType
		{
			get;
			private set;
		}

		/// <summary>
		/// Creates a new text options item
		/// </summary>
		/// <param name="presentationType">The way the setting is presented</param>
		/// <param name="name">Name/title of the item, shown in a label</param>
		/// <param name="description">The description of the item. Shown in a label / textblock</param>
		public TextOptionsItem(
			DisplayType presentationType,
			string name,
			string description )
			: base( name, description )
		{
			PresentationType = presentationType;
		}

		/// <summary>
		/// The way the setting is presented
		/// </summary>
		public enum DisplayType
		{
			/// <summary>
			/// Creates a label with the description in it. Use it for short texts only.
			/// If a name is given, it is presented in another label near it.
			/// </summary>
			Label,
			/// <summary>
			/// Creates a readonly scrollable textblock with the description in it.
			/// If a name is given, it is presented in a label over the textblock.
			/// </summary>
			TextBlock
		}
	}
}
